Vcenter Guest WindowsConfiguration

The Vcenter Guest WindowsConfiguration schema specifies the settings for customizing a windows guest operating system.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "reboot": "string",
    "sysprep": {
        "gui_run_once_commands": [
            "string"
        ],
        "user_data": {
            "computer_name": {
                "type": "string",
                "fixed_name": "string",
                "prefix": "string"
            },
            "full_name": "string",
            "organization": "string",
            "product_key": "string"
        },
        "domain": {
            "type": "string",
            "workgroup": "string",
            "domain": "string",
            "domain_username": "string",
            "domain_password": "string",
            "domain_ou": "string"
        },
        "gui_unattended": {
            "auto_logon": false,
            "auto_logon_count": 0,
            "password": "string",
            "time_zone": 0
        }
    },
    "sysprep_xml": "string"
}

string

reboot

Optional

A value specifying the action that should be taken after customization.

For more information see: Vcenter Guest WindowsConfiguration RebootOption.

This property was added in vSphere API 7.0.0.0.

If missing or null, the Vcenter Guest WindowsConfiguration RebootOption.REBOOT option will be chosen.

sysprep

Optional

Customization settings like user details, administrator details, etc for the windows guest operating system. Exactly one of sysprep or sysprep_xml must be specified.

This property was added in vSphere API 7.0.0.0.

If missing or null, sysprep settings will not be applied to the windows guest operating system.

string

sysprep_xml

Optional

All settings specified in a XML format. This is the content of a typical answer.xml file that is used by System administrators during the Windows image customization. Check https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs Exactly one of sysprep or sysprep_xml must be specified.

This property was added in vSphere API 7.0.0.0.

If missing or null, sysprep settings will not be applied to the windows guest operating system.